Skip to content

SEP 1 -- SEP指南

Head

  • Author: larry
  • Status: Active
  • Type: Informational
  • Created: 2017-07-13

SEP是什么

SEP是System Enhancement Proposal。SEP借鉴了python pep的模式。

每个SEP表达了对系统的改变建议、主要集中在非产品需求方面,尤其是系统优化方面。

之所以用这种方式,是因为产品需求有专人提需求,写文档,专人跟进项目,所以能够正常进展。但是系统优化因为没有专人提需求,也没有需求文档,使得需求排期变得很随意,很多时候甚至忘记了有这个需求,直到问题再次发生了才想起来。

系统优化也是需求,应该类似产品需求,有需求追踪排期机制,SEP就是为了做这个事。

即使对于最终不去完成的SEP,保留文档也是有意义的。

SEP-1是指南、SEP-0是所有SEP的index。

SEP Types

  • Standards: 常规改进。通常意味着对系统功能的改进。
  • Informational: 信息类。通常是指南或者风格建议,不对系统做明确的改变。

SEP工作流

SEP Status

  1. draft:草稿模式。刚提出的sep,尚未被评审通过。
  2. Accepted:大家讨论后觉得可行,批准通过。但功能尚未完全实现,或者处于实现中。
  3. Final:已经实现完成。
  4. Active:活跃。有些sep建议会长期处于活跃状态,不会关闭。
  5. Deferred:推后。建议有意义,但是短期难以实现。
  6. Withdrawn:退出。作者主动取消建议,或者已经被其他sep实现了。
  7. Rejected:拒绝。经讨论后认为不适合。

SEP流程

  1. 作者(可以是多个)提出sep草稿,编号请去doc里找。sep进入draft状态.
  2. 作者发送邮件给g_tech@guanmai.cn,给所有人review和讨论,随后不断修改完善sep,修改完成后管理员批准通过,状态改为Accepted。
  3. 进入Accepted状态后,开始准备排期实现。
  4. 如果经过讨论发现不适合,作者可以把状态改为Withdrawn,表示停止前进。或者经讨论后Rejected。

SEP格式

  1. 标题:比如,SEP 1 -- SEP指南。
  2. 摘要:200字的简短描述。必选。
  3. 动机:描述发起建议的原因。
  4. 描述:详细描述改进思路,这里开始可以用任何自拟的标题。